Skip to main content

Integration Enabled

This webhook is sent when an integration is enabled by a retailer. The json configuration allows for an integration to configure ui elements that will have the result of the configuration sent back to the integration. This allows for the integration to request information from the retailer that is needed to complete the integration. The integration can then use this information to identify the retailer and the user that enabled the integration.

Request Body​

The request body must be a JSON object with the following properties:

  • retailerId (string, required): The ID of the retailer that enabled the integration.
  • retailerName (string): The name of the retailer that enabled the integration.
  • retailerAddress (string): The address of the retailer that enabled the integration.
  • enabledBy (object, nullable): Information about the user who enabled the integration. Will be null if the user cannot be found.
    • userId (string): The ID of the user.
    • firstName (string): The first name of the user.
    • lastName (string): The last name of the user.
    • email (string): The email address of the user.
    • phoneNumber (string): The phone number of the user.
  • configJson (object): A JSON object containing the result of the configuration for the integration. Only present if the integration has configuration.

Example Request Body​

{
  "retailerId": "ebed869d-bdf4-4b0a-8442-5b8f23753247",
  "retailerName": "Bobs Motors",
  "retailerAddress": "123 Main street SW, Toronto, ON, M1M 1M1",
  "enabledBy": {
    "userId": "ebed869d-bdf4-4b0a-8442-5b8f23753247",
    "firstName": "Bob",
    "lastName": "Smith",
    "email": "bob.smith@bobsmotors.ca",
    "phoneNumber": "123-456-7890"
  },
  "configJson": {
    "token": "some requested item"
  }
}